home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 2002 November / SGI Freeware 2002 November - Disc 1.iso / dist / fw_apache2.idb / usr / freeware / apache2 / include / httpd.h.z / httpd.h
C/C++ Source or Header  |  2002-07-08  |  61KB  |  1,732 lines
  1. /* ====================================================================
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 2000-2002 The Apache Software Foundation.  All rights
  5.  * reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  *
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer.
  13.  *
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  *
  19.  * 3. The end-user documentation included with the redistribution,
  20.  *    if any, must include the following acknowledgment:
  21.  *       "This product includes software developed by the
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowledgment may appear in the software itself,
  24.  *    if and wherever such third-party acknowledgments normally appear.
  25.  *
  26.  * 4. The names "Apache" and "Apache Software Foundation" must
  27.  *    not be used to endorse or promote products derived from this
  28.  *    software without prior written permission. For written
  29.  *    permission, please contact apache@apache.org.
  30.  *
  31.  * 5. Products derived from this software may not be called "Apache",
  32.  *    nor may "Apache" appear in their name, without prior written
  33.  *    permission of the Apache Software Foundation.
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  *
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation.  For more
  51.  * information on the Apache Software Foundation, please see
  52.  * <http://www.apache.org/>.
  53.  *
  54.  * Portions of this software are based upon public domain software
  55.  * originally written at the National Center for Supercomputing Applications,
  56.  * University of Illinois, Urbana-Champaign.
  57.  */
  58.  
  59. #ifndef APACHE_HTTPD_H
  60. #define APACHE_HTTPD_H
  61.  
  62. /**
  63.  * @file httpd.h
  64.  * @brief HTTP Daemon routines
  65.  */
  66.  
  67. /* XXX - We need to push more stuff to other .h files, or even .c files, to
  68.  * make this file smaller
  69.  */
  70.  
  71. /* Headers in which EVERYONE has an interest... */
  72. #include "ap_config.h"
  73. #include "ap_mmn.h"
  74.  
  75. #include "ap_release.h"
  76. #include "os.h"
  77.  
  78. #include "apr_general.h"
  79. #include "apr_tables.h"
  80. #include "apr_pools.h"
  81. #include "apr_time.h"
  82. #include "apr_network_io.h"
  83. #include "apr_buckets.h"
  84.  
  85. #include "pcreposix.h"
  86.  
  87. /* Note: util_uri.h is also included, see below */
  88.  
  89. #ifdef __cplusplus
  90. extern "C" {
  91. #endif
  92.  
  93. #ifdef CORE_PRIVATE
  94.  
  95. /* ----------------------------- config dir ------------------------------ */
  96.  
  97. /* Define this to be the default server home dir. Most things later in this
  98.  * file with a relative pathname will have this added.
  99.  */
  100. #ifndef HTTPD_ROOT
  101. #ifdef OS2
  102. /* Set default for OS/2 file system */
  103. #define HTTPD_ROOT "/os2httpd"
  104. #elif defined(WIN32)
  105. /* Set default for Windows file system */
  106. #define HTTPD_ROOT "/apache"
  107. #elif defined (BEOS)
  108. /* Set the default for BeOS */
  109. #define HTTPD_ROOT "/boot/home/apache"
  110. #elif defined (NETWARE)
  111. /* Set the default for NetWare */
  112. #define HTTPD_ROOT "/apache"
  113. #else
  114. #define HTTPD_ROOT "/usr/local/apache"
  115. #endif
  116. #endif /* HTTPD_ROOT */
  117.  
  118. /* 
  119.  * --------- You shouldn't have to edit anything below this line ----------
  120.  *
  121.  * Any modifications to any defaults not defined above should be done in the 
  122.  * respective configuration file. 
  123.  *
  124.  */
  125.  
  126. /* Default location of documents.  Can be overridden by the DocumentRoot
  127.  * directive.
  128.  */
  129. #ifndef DOCUMENT_LOCATION
  130. #ifdef OS2
  131. /* Set default for OS/2 file system */
  132. #define DOCUMENT_LOCATION  HTTPD_ROOT "/docs"
  133. #else
  134. #define DOCUMENT_LOCATION  HTTPD_ROOT "/htdocs"
  135. #endif
  136. #endif /* DOCUMENT_LOCATION */
  137.  
  138. /* Maximum number of dynamically loaded modules */
  139. #ifndef DYNAMIC_MODULE_LIMIT
  140. #define DYNAMIC_MODULE_LIMIT 64
  141. #endif
  142.  
  143. /* Default administrator's address */
  144. #define DEFAULT_ADMIN "[no address given]"
  145.  
  146. /* The name of the log files */
  147. #ifndef DEFAULT_ERRORLOG
  148. #if defined(OS2) || defined(WIN32)
  149. #define DEFAULT_ERRORLOG "logs/error.log"
  150. #else
  151. #define DEFAULT_ERRORLOG "logs/error_log"
  152. #endif
  153. #endif /* DEFAULT_ERRORLOG */
  154.  
  155. /* Define this to be what your per-directory security files are called */
  156. #ifndef DEFAULT_ACCESS_FNAME
  157. #ifdef OS2
  158. /* Set default for OS/2 file system */
  159. #define DEFAULT_ACCESS_FNAME "htaccess"
  160. #else
  161. #define DEFAULT_ACCESS_FNAME ".htaccess"
  162. #endif
  163. #endif /* DEFAULT_ACCESS_FNAME */
  164.  
  165. /* The name of the server config file */
  166. #ifndef SERVER_CONFIG_FILE
  167. #define SERVER_CONFIG_FILE "conf/httpd.conf"
  168. #endif
  169.  
  170. /* Whether we should enable rfc1413 identity checking */
  171. #ifndef DEFAULT_RFC1413
  172. #define DEFAULT_RFC1413 0
  173. #endif
  174.  
  175. /* The default path for CGI scripts if none is currently set */
  176. #ifndef DEFAULT_PATH
  177. #define DEFAULT_PATH "/bin:/usr/bin:/usr/ucb:/usr/bsd:/usr/local/bin"
  178. #endif
  179.  
  180. /* The path to the suExec wrapper, can be overridden in Configuration */
  181. #ifndef SUEXEC_BIN
  182. #define SUEXEC_BIN  HTTPD_ROOT "/bin/suexec"
  183. #endif
  184.  
  185. /* The timeout for waiting for messages */
  186. #ifndef DEFAULT_TIMEOUT
  187. #define DEFAULT_TIMEOUT 300 
  188. #endif
  189.  
  190. /* The timeout for waiting for keepalive timeout until next request */
  191. #ifndef DEFAULT_KEEPALIVE_TIMEOUT
  192. #define DEFAULT_KEEPALIVE_TIMEOUT 15
  193. #endif
  194.  
  195. /* The number of requests to entertain per connection */
  196. #ifndef DEFAULT_KEEPALIVE
  197. #define DEFAULT_KEEPALIVE 100
  198. #endif
  199.  
  200. /* Limits on the size of various request items.  These limits primarily
  201.  * exist to prevent simple denial-of-service attacks on a server based
  202.  * on misuse of the protocol.  The recommended values will depend on the
  203.  * nature of the server resources -- CGI scripts and database backends
  204.  * might require large values, but most servers could get by with much
  205.  * smaller limits than we use below.  The request message body size can
  206.  * be limited by the per-dir config directive LimitRequestBody.
  207.  *
  208.  * Internal buffer sizes are two bytes more than the DEFAULT_LIMIT_REQUEST_LINE
  209.  * and DEFAULT_LIMIT_REQUEST_FIELDSIZE below, which explains the 8190.
  210.  * These two limits can be lowered (but not raised) by the server config
  211.  * directives LimitRequestLine and LimitRequestFieldsize, respectively.
  212.  *
  213.  * DEFAULT_LIMIT_REQUEST_FIELDS can be modified or disabled (set = 0) by
  214.  * the server config directive LimitRequestFields.
  215.  */
  216. #ifndef DEFAULT_LIMIT_REQUEST_LINE
  217. #define DEFAULT_LIMIT_REQUEST_LINE 8190
  218. #endif /* default limit on bytes in Request-Line (Method+URI+HTTP-version) */
  219. #ifndef DEFAULT_LIMIT_REQUEST_FIELDSIZE
  220. #define DEFAULT_LIMIT_REQUEST_FIELDSIZE 8190
  221. #endif /* default limit on bytes in any one header field  */
  222. #ifndef DEFAULT_LIMIT_REQUEST_FIELDS
  223. #define DEFAULT_LIMIT_REQUEST_FIELDS 100
  224. #endif /* default limit on number of request header fields */
  225.  
  226.  
  227. /**
  228.  * The default default character set name to add if AddDefaultCharset is
  229.  * enabled.  Overridden with AddDefaultCharsetName.
  230.  */
  231. #define DEFAULT_ADD_DEFAULT_CHARSET_NAME "iso-8859-1"
  232.  
  233. #endif /* CORE_PRIVATE */
  234.  
  235. /** default HTTP Server protocol */
  236. #define AP_SERVER_PROTOCOL "HTTP/1.1"
  237.  
  238.  
  239. /* ------------------ stuff that modules are allowed to look at ----------- */
  240.  
  241. /** Define this to be what your HTML directory content files are called */
  242. #ifndef AP_DEFAULT_INDEX
  243. #define AP_DEFAULT_INDEX "index.html"
  244. #endif
  245.  
  246.  
  247. /** 
  248.  * Define this to be what type you'd like returned for files with unknown 
  249.  * suffixes.  
  250.  * @warning MUST be all lower case. 
  251.  */
  252. #ifndef DEFAULT_CONTENT_TYPE
  253. #define DEFAULT_CONTENT_TYPE "text/plain"
  254. #endif
  255.  
  256. /** The name of the MIME types file */
  257. #ifndef AP_TYPES_CONFIG_FILE
  258. #define AP_TYPES_CONFIG_FILE "conf/mime.types"
  259. #endif
  260.  
  261. /*
  262.  * Define the HTML doctype strings centrally.
  263.  */
  264. /** HTML 2.0 Doctype */
  265. #define DOCTYPE_HTML_2_0  "<!DOCTYPE HTML PUBLIC \"-//IETF//" \
  266.                           "DTD HTML 2.0//EN\">\n"
  267. /** HTML 3.2 Doctype */
  268. #define DOCTYPE_HTML_3_2  "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
  269.                           "DTD HTML 3.2 Final//EN\">\n"
  270. /** HTML 4.0 Strict Doctype */
  271. #define DOCTYPE_HTML_4_0S "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
  272.                           "DTD HTML 4.0//EN\"\n" \
  273.                           "\"http://www.w3.org/TR/REC-html40/strict.dtd\">\n"
  274. /** HTML 4.0 Transitional Doctype */
  275. #define DOCTYPE_HTML_4_0T "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
  276.                           "DTD HTML 4.0 Transitional//EN\"\n" \
  277.                           "\"http://www.w3.org/TR/REC-html40/loose.dtd\">\n"
  278. /** HTML 4.0 Frameset Doctype */
  279. #define DOCTYPE_HTML_4_0F "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
  280.                           "DTD HTML 4.0 Frameset//EN\"\n" \
  281.                           "\"http://www.w3.org/TR/REC-html40/frameset.dtd\">\n"
  282.  
  283. /** Internal representation for a HTTP protocol number, e.g., HTTP/1.1 */
  284.  
  285. #define HTTP_VERSION(major,minor) (1000*(major)+(minor))
  286. /** Major part of HTTP protocol */
  287. #define HTTP_VERSION_MAJOR(number) ((number)/1000)
  288. /** Minor part of HTTP protocol */
  289. #define HTTP_VERSION_MINOR(number) ((number)%1000)
  290.  
  291. /* -------------- Port number for server running standalone --------------- */
  292.  
  293. /** default HTTP Port */
  294. #define DEFAULT_HTTP_PORT    80
  295. /** default HTTPS Port */
  296. #define DEFAULT_HTTPS_PORT    443
  297. /**
  298.  * Check whether @a port is the default port for the request @a r.
  299.  * @param port The port number
  300.  * @param r The request
  301.  * @see #ap_default_port
  302.  */
  303. #define ap_is_default_port(port,r)    ((port) == ap_default_port(r))
  304. /**
  305.  * Get the default port for a request (which depends on the scheme).
  306.  * @param r The request
  307.  */
  308. #define ap_default_port(r)    ap_run_default_port(r)
  309. /**
  310.  * Get the scheme for a request.
  311.  * @param r The request
  312.  * @bug This should be called ap_http_scheme!
  313.  */
  314. #define ap_http_method(r)    ap_run_http_method(r)
  315.  
  316. /** The default string lengths */
  317. #define MAX_STRING_LEN HUGE_STRING_LEN
  318. #define HUGE_STRING_LEN 8192
  319.  
  320. /** The size of the server's internal read-write buffers */
  321. #define AP_IOBUFSIZE 8192
  322.  
  323. /**
  324.  * APR_HAS_LARGE_FILES introduces the problem of spliting sendfile into 
  325.  * mutiple buckets, no greater than MAX(apr_size_t), and more granular 
  326.  * than that in case the brigade code/filters attempt to read it directly.
  327.  * ### 16mb is an invention, no idea if it is reasonable.
  328.  */
  329. #define AP_MAX_SENDFILE 16777216  /* 2^24 */
  330.  
  331. /**
  332.  * Special Apache error codes. These are basically used
  333.  *  in http_main.c so we can keep track of various errors.
  334.  *        
  335.  */
  336. /** a normal exit */
  337. #define APEXIT_OK        0x0
  338. /** A fatal error arising during the server's init sequence */
  339. #define APEXIT_INIT        0x2
  340. /**  The child died during its init sequence */
  341. #define APEXIT_CHILDINIT    0x3
  342. /**  
  343.  *   The child exited due to a resource shortage.
  344.  *   The parent should limit the rate of forking until
  345.  *   the situation is resolved.
  346.  */
  347. #define APEXIT_CHILDSICK        0x7
  348. /** 
  349.  *     A fatal error, resulting in the whole server aborting.
  350.  *     If a child exits with this error, the parent process
  351.  *     considers this a server-wide fatal error and aborts.
  352.  */
  353. #define APEXIT_CHILDFATAL    0xf
  354.  
  355. #ifndef AP_DECLARE
  356. /**
  357.  * Stuff marked #AP_DECLARE is part of the API, and intended for use
  358.  * by modules. Its purpose is to allow us to add attributes that
  359.  * particular platforms or compilers require to every exported function.
  360.  */
  361. # define AP_DECLARE(type)    type
  362. #endif
  363.  
  364. #ifndef AP_DECLARE_NONSTD
  365. /**
  366.  * Stuff marked #AP_DECLARE_NONSTD is part of the API, and intended for
  367.  * use by modules.  The difference between #AP_DECLARE and
  368.  * #AP_DECLARE_NONSTD is that the latter is required for any functions
  369.  * which use varargs or are used via indirect function call.  This
  370.  * is to accomodate the two calling conventions in windows dlls.
  371.  */
  372. # define AP_DECLARE_NONSTD(type)    type
  373. #endif
  374. #ifndef AP_DECLARE_DATA
  375. # define AP_DECLARE_DATA
  376. #endif
  377.  
  378. #ifndef AP_MODULE_DECLARE
  379. # define AP_MODULE_DECLARE(type)    type
  380. #endif
  381. #ifndef AP_MODULE_DECLARE_NONSTD
  382. # define AP_MODULE_DECLARE_NONSTD(type)  type
  383. #endif
  384. #ifndef AP_MODULE_DECLARE_DATA
  385. # define AP_MODULE_DECLARE_DATA
  386. #endif
  387.  
  388. /**
  389.  * @internal
  390.  * modules should not used functions marked AP_CORE_DECLARE
  391.  */
  392. #ifndef AP_CORE_DECLARE
  393. # define AP_CORE_DECLARE    AP_DECLARE
  394. #endif
  395. /**
  396.  * @internal
  397.  * modules should not used functions marked AP_CORE_DECLARE_NONSTD
  398.  */
  399.  
  400. #ifndef AP_CORE_DECLARE_NONSTD
  401. # define AP_CORE_DECLARE_NONSTD    AP_DECLARE_NONSTD
  402. #endif
  403.  
  404. /**
  405.  * Get the server version string
  406.  * @return The server version string
  407.  */
  408. AP_DECLARE(const char *) ap_get_server_version(void);
  409.  
  410. /**
  411.  * Add a component to the version string
  412.  * @param pconf The pool to allocate the component from
  413.  * @param component The string to add
  414.  */
  415. AP_DECLARE(void) ap_add_version_component(apr_pool_t *pconf, const char *component);
  416.  
  417. /**
  418.  * Get the date a time that the server was built
  419.  * @return The server build time string
  420.  */
  421. AP_DECLARE(const char *) ap_get_server_built(void);
  422.  
  423. #define DECLINED -1        /**< Module declines to handle */
  424. #define DONE -2            /**< Module has served the response completely 
  425.                  *  - it's safe to die() with no more output
  426.                  */
  427. #define OK 0            /**< Module has handled this stage. */
  428.  
  429.  
  430. /**
  431.  * @defgroup HTTP_Status HTTP Status Codes
  432.  * @{
  433.  */
  434. /**
  435.  * The size of the static array in http_protocol.c for storing
  436.  * all of the potential response status-lines (a sparse table).
  437.  * A future version should dynamically generate the apr_table_t at startup.
  438.  */
  439. #define RESPONSE_CODES 55
  440.  
  441. #define HTTP_CONTINUE                      100
  442. #define HTTP_SWITCHING_PROTOCOLS           101
  443. #define HTTP_PROCESSING                    102
  444. #define HTTP_OK                            200
  445. #define HTTP_CREATED                       201
  446. #define HTTP_ACCEPTED                      202
  447. #define HTTP_NON_AUTHORITATIVE             203
  448. #define HTTP_NO_CONTENT                    204
  449. #define HTTP_RESET_CONTENT                 205
  450. #define HTTP_PARTIAL_CONTENT               206
  451. #define HTTP_MULTI_STATUS                  207
  452. #define HTTP_MULTIPLE_CHOICES              300
  453. #define HTTP_MOVED_PERMANENTLY             301
  454. #define HTTP_MOVED_TEMPORARILY             302
  455. #define HTTP_SEE_OTHER                     303
  456. #define HTTP_NOT_MODIFIED                  304
  457. #define HTTP_USE_PROXY                     305
  458. #define HTTP_TEMPORARY_REDIRECT            307
  459. #define HTTP_BAD_REQUEST                   400
  460. #define HTTP_UNAUTHORIZED                  401
  461. #define HTTP_PAYMENT_REQUIRED              402
  462. #define HTTP_FORBIDDEN                     403
  463. #define HTTP_NOT_FOUND                     404
  464. #define HTTP_METHOD_NOT_ALLOWED            405
  465. #define HTTP_NOT_ACCEPTABLE                406
  466. #define HTTP_PROXY_AUTHENTICATION_REQUIRED 407
  467. #define HTTP_REQUEST_TIME_OUT              408
  468. #define HTTP_CONFLICT                      409
  469. #define HTTP_GONE                          410
  470. #define HTTP_LENGTH_REQUIRED               411
  471. #define HTTP_PRECONDITION_FAILED           412
  472. #define HTTP_REQUEST_ENTITY_TOO_LARGE      413
  473. #define HTTP_REQUEST_URI_TOO_LARGE         414
  474. #define HTTP_UNSUPPORTED_MEDIA_TYPE        415
  475. #define HTTP_RANGE_NOT_SATISFIABLE         416
  476. #define HTTP_EXPECTATION_FAILED            417
  477. #define HTTP_UNPROCESSABLE_ENTITY          422
  478. #define HTTP_LOCKED                        423
  479. #define HTTP_FAILED_DEPENDENCY             424
  480. #define HTTP_INTERNAL_SERVER_ERROR         500
  481. #define HTTP_NOT_IMPLEMENTED               501
  482. #define HTTP_BAD_GATEWAY                   502
  483. #define HTTP_SERVICE_UNAVAILABLE           503
  484. #define HTTP_GATEWAY_TIME_OUT              504
  485. #define HTTP_VERSION_NOT_SUPPORTED         505
  486. #define HTTP_VARIANT_ALSO_VARIES           506
  487. #define HTTP_INSUFFICIENT_STORAGE          507
  488. #define HTTP_NOT_EXTENDED                  510
  489.  
  490. /** is the status code informational */
  491. #define ap_is_HTTP_INFO(x)         (((x) >= 100)&&((x) < 200))
  492. /** is the status code OK ?*/
  493. #define ap_is_HTTP_SUCCESS(x)      (((x) >= 200)&&((x) < 300))
  494. /** is the status code a redirect */
  495. #define ap_is_HTTP_REDIRECT(x)     (((x) >= 300)&&((x) < 400))
  496. /** is the status code a error (client or server) */
  497. #define ap_is_HTTP_ERROR(x)        (((x) >= 400)&&((x) < 600))
  498. /** is the status code a client error  */
  499. #define ap_is_HTTP_CLIENT_ERROR(x) (((x) >= 400)&&((x) < 500))
  500. /** is the status code a server error  */
  501. #define ap_is_HTTP_SERVER_ERROR(x) (((x) >= 500)&&((x) < 600))
  502.  
  503. /** should the status code drop the connection */
  504. #define ap_status_drops_connection(x) \
  505.                                    (((x) == HTTP_BAD_REQUEST)           || \
  506.                                     ((x) == HTTP_REQUEST_TIME_OUT)      || \
  507.                                     ((x) == HTTP_LENGTH_REQUIRED)       || \
  508.                                     ((x) == HTTP_REQUEST_ENTITY_TOO_LARGE) || \
  509.                                     ((x) == HTTP_REQUEST_URI_TOO_LARGE) || \
  510.                                     ((x) == HTTP_INTERNAL_SERVER_ERROR) || \
  511.                                     ((x) == HTTP_SERVICE_UNAVAILABLE) || \
  512.                     ((x) == HTTP_NOT_IMPLEMENTED))
  513. /** @} */
  514. /**
  515.  * @defgroup Methods List of Methods recognized by the server
  516.  * @{
  517.  */
  518. /**
  519.  * Methods recognized (but not necessarily handled) by the server.
  520.  * These constants are used in bit shifting masks of size int, so it is
  521.  * unsafe to have more methods than bits in an int.  HEAD == M_GET.
  522.  * This list must be tracked by the list in http_protocol.c in routine
  523.  * ap_method_name_of().
  524.  */
  525. #define M_GET                   0       /* RFC 2616: HTTP */
  526. #define M_PUT                   1       /*  :             */
  527. #define M_POST                  2
  528. #define M_DELETE                3
  529. #define M_CONNECT               4
  530. #define M_OPTIONS               5
  531. #define M_TRACE                 6       /* RFC 2616: HTTP */
  532. #define M_PATCH                 7       /* no rfc(!)  ### remove this one? */
  533. #define M_PROPFIND              8       /* RFC 2518: WebDAV */
  534. #define M_PROPPATCH             9       /*  :               */
  535. #define M_MKCOL                 10
  536. #define M_COPY                  11
  537. #define M_MOVE                  12
  538. #define M_LOCK                  13
  539. #define M_UNLOCK                14      /* RFC 2518: WebDAV */
  540. #define M_VERSION_CONTROL       15      /* RFC 3253: WebDAV Versioning */
  541. #define M_CHECKOUT              16      /*  :                          */
  542. #define M_UNCHECKOUT            17
  543. #define M_CHECKIN               18
  544. #define M_UPDATE                19
  545. #define M_LABEL                 20
  546. #define M_REPORT                21
  547. #define M_MKWORKSPACE           22
  548. #define M_MKACTIVITY            23
  549. #define M_BASELINE_CONTROL      24
  550. #define M_MERGE                 25
  551. #define M_INVALID               26      /* RFC 3253: WebDAV Versioning */
  552.  
  553. /**
  554.  * METHODS needs to be equal to the number of bits
  555.  * we are using for limit masks.
  556.  */
  557. #define METHODS     64
  558.  
  559. /**
  560.  * The method mask bit to shift for anding with a bitmask.
  561.  */
  562. #define AP_METHOD_BIT ((apr_int64_t)1)
  563. /** @} */
  564.  
  565.  
  566. /**
  567.  * Structure for handling HTTP methods.  Methods known to the server are
  568.  * accessed via a bitmask shortcut; extension methods are handled by
  569.  * an array.
  570.  */
  571. typedef struct ap_method_list_t ap_method_list_t;
  572. struct ap_method_list_t {
  573.     /* The bitmask used for known methods */
  574.     apr_int64_t method_mask;
  575.     /* the array used for extension methods */
  576.     apr_array_header_t *method_list;
  577. };
  578. /**
  579.  * @defgroup module_magic Module Magic mime types
  580.  * @{
  581.  */
  582. /** Magic for mod_cgi[d] */
  583. #define CGI_MAGIC_TYPE "application/x-httpd-cgi"
  584. /** Magic for mod_include */
  585. #define INCLUDES_MAGIC_TYPE "text/x-server-parsed-html"
  586. /** Magic for mod_include */
  587. #define INCLUDES_MAGIC_TYPE3 "text/x-server-parsed-html3"
  588. /** Magic for mod_dir */
  589. #define DIR_MAGIC_TYPE "httpd/unix-directory"
  590.  
  591. /** @} */
  592. /* Just in case your linefeed isn't the one the other end is expecting. */
  593. #if !APR_CHARSET_EBCDIC
  594. /** linefeed */
  595. #define LF 10
  596. /** carrige return */
  597. #define CR 13
  598. /** carrige return /Line Feed Combo */
  599. #define CRLF "\015\012"
  600. #else /* APR_CHARSET_EBCDIC */
  601. /* For platforms using the EBCDIC charset, the transition ASCII->EBCDIC is done
  602.  * in the buff package (bread/bputs/bwrite).  Everywhere else, we use
  603.  * "native EBCDIC" CR and NL characters. These are therefore
  604.  * defined as
  605.  * '\r' and '\n'.
  606.  */
  607. #define CR '\r'
  608. #define LF '\n'
  609. #define CRLF "\r\n"
  610. #endif /* APR_CHARSET_EBCDIC */                                   
  611.  
  612. /**
  613.  * @defgroup values_request_rec_body Possible values for request_rec.read_body 
  614.  * @{
  615.  * Possible values for request_rec.read_body (set by handling module):
  616.  */
  617.  
  618. /** Send 413 error if message has any body */
  619. #define REQUEST_NO_BODY          0
  620. /** Send 411 error if body without Content-Length */
  621. #define REQUEST_CHUNKED_ERROR    1
  622. /** If chunked, remove the chunks for me. */
  623. #define REQUEST_CHUNKED_DECHUNK  2
  624. /** @} */
  625.  
  626. /**
  627.  * @defgroup values_request_rec_used_path_info Possible values for request_rec.used_path_info 
  628.  * @{
  629.  * Possible values for request_rec.used_path_info:
  630.  */
  631.  
  632. /** Accept the path_info from the request */
  633. #define AP_REQ_ACCEPT_PATH_INFO    0
  634. /** Return a 404 error if path_info was given */
  635. #define AP_REQ_REJECT_PATH_INFO    1
  636. /** Module may chose to use the given path_info */
  637. #define AP_REQ_DEFAULT_PATH_INFO   2
  638. /** @} */
  639.  
  640. /*
  641.  * Things which may vary per file-lookup WITHIN a request ---
  642.  * e.g., state of MIME config.  Basically, the name of an object, info
  643.  * about the object, and any other info we may ahve which may need to
  644.  * change as we go poking around looking for it (e.g., overridden by
  645.  * .htaccess files).
  646.  *
  647.  * Note how the default state of almost all these things is properly
  648.  * zero, so that allocating it with pcalloc does the right thing without
  649.  * a whole lot of hairy initialization... so long as we are willing to
  650.  * make the (fairly) portable assumption that the bit pattern of a NULL
  651.  * pointer is, in fact, zero.
  652.  */
  653.  
  654. /**
  655.  * This represents the result of calling htaccess; these are cached for
  656.  * each request.
  657.  */
  658. struct htaccess_result {
  659.     /** the directory to which this applies */
  660.     const char *dir;
  661.     /** the overrides allowed for the .htaccess file */
  662.     int override;
  663.     /** the configuration directives */
  664.     struct ap_conf_vector_t *htaccess;
  665.     /** the next one, or NULL if no more; N.B. never change this */
  666.     const struct htaccess_result *next;
  667. };
  668.  
  669. /* The following four types define a hierarchy of activities, so that
  670.  * given a request_rec r you can write r->connection->server->process
  671.  * to get to the process_rec.  While this reduces substantially the
  672.  * number of arguments that various hooks require beware that in
  673.  * threaded versions of the server you must consider multiplexing
  674.  * issues.  */
  675.  
  676.  
  677. /** A structure that represents one process */
  678. typedef struct process_rec process_rec;
  679. /** A structure that represents a virtual server */
  680. typedef struct server_rec server_rec;
  681. /** A structure that represents one connection */
  682. typedef struct conn_rec conn_rec;
  683. /** A structure that represents the current request */
  684. typedef struct request_rec request_rec;
  685.  
  686. /* ### would be nice to not include this from httpd.h ... */
  687. /* This comes after we have defined the request_rec type */
  688. #include "apr_uri.h"
  689.  
  690. /** A structure that represents one process */
  691. struct process_rec {
  692.     /** Global pool. Cleared upon normal exit */
  693.     apr_pool_t *pool;
  694.     /** Configuration pool. Cleared upon restart */
  695.     apr_pool_t *pconf;
  696.     /** Number of command line arguments passed to the program */
  697.     int argc;
  698.     /** The command line arguments */
  699.     const char * const *argv;
  700.     /** The program name used to execute the program */
  701.     const char *short_name;
  702. };
  703.  
  704. /** A structure that represents the current request */
  705. struct request_rec {
  706.     /** The pool associated with the request */
  707.     apr_pool_t *pool;
  708.     /** The connection to the client */
  709.     conn_rec *connection;
  710.     /** The virtual host for this request */
  711.     server_rec *server;
  712.  
  713.     /** Pointer to the redirected request if this is an external redirect */
  714.     request_rec *next;
  715.     /** Pointer to the previous request if this is an internal redirect */
  716.     request_rec *prev;
  717.  
  718.     /** Pointer to the main request if this is a sub-request (see request.h) */
  719.     request_rec *main;
  720.  
  721.     /* Info about the request itself... we begin with stuff that only
  722.      * protocol.c should ever touch...
  723.      */
  724.     /** First line of request */
  725.     char *the_request;
  726.     /** HTTP/0.9, "simple" request (e.g. GET /foo\n w/no headers) */
  727.     int assbackwards;
  728.     /** A proxy request (calculated during post_read_request/translate_name)
  729.      *  possible values PROXYREQ_NONE, PROXYREQ_PROXY, PROXYREQ_REVERSE,
  730.      *                  PROXYREQ_RESPONSE
  731.      */
  732.     int proxyreq;
  733.     /** HEAD request, as opposed to GET */
  734.     int header_only;
  735.     /** Protocol string, as given to us, or HTTP/0.9 */
  736.     char *protocol;
  737.     /** Protocol version number of protocol; 1.1 = 1001 */
  738.     int proto_num;
  739.     /** Host, as set by full URI or Host: */
  740.     const char *hostname;
  741.  
  742.     /** Time when the request started */
  743.     apr_time_t request_time;
  744.  
  745.     /** Status line, if set by script */
  746.     const char *status_line;
  747.     /** Status line */
  748.     int status;
  749.  
  750.     /* Request method, two ways; also, protocol, etc..  Outside of protocol.c,
  751.      * look, but don't touch.
  752.      */
  753.  
  754.     /** Request method (eg. GET, HEAD, POST, etc.) */
  755.     const char *method;
  756.     /** M_GET, M_POST, etc. */
  757.     int method_number;
  758.  
  759.     /**
  760.      *  'allowed' is a bitvector of the allowed methods.
  761.      *
  762.      *  A handler must ensure that the request method is one that
  763.      *  it is capable of handling.  Generally modules should DECLINE
  764.      *  any request methods they do not handle.  Prior to aborting the
  765.      *  handler like this the handler should set r->allowed to the list
  766.      *  of methods that it is willing to handle.  This bitvector is used
  767.      *  to construct the "Allow:" header required for OPTIONS requests,
  768.      *  and HTTP_METHOD_NOT_ALLOWED and HTTP_NOT_IMPLEMENTED status codes.
  769.      *
  770.      *  Since the default_handler deals with OPTIONS, all modules can
  771.      *  usually decline to deal with OPTIONS.  TRACE is always allowed,
  772.      *  modules don't need to set it explicitly.
  773.      *
  774.      *  Since the default_handler will always handle a GET, a
  775.      *  module which does *not* implement GET should probably return
  776.      *  HTTP_METHOD_NOT_ALLOWED.  Unfortunately this means that a Script GET
  777.      *  handler can't be installed by mod_actions.
  778.      */
  779.     apr_int64_t allowed;
  780.     /** Array of extension methods */
  781.     apr_array_header_t *allowed_xmethods; 
  782.     /** List of allowed methods */
  783.     ap_method_list_t *allowed_methods; 
  784.  
  785.     /** byte count in stream is for body */
  786.     apr_off_t sent_bodyct;
  787.     /** body byte count, for easy access */
  788.     apr_off_t bytes_sent;
  789.     /** Last modified time of the requested resource */
  790.     apr_time_t mtime;
  791.  
  792.     /* HTTP/1.1 connection-level features */
  793.  
  794.     /** sending chunked transfer-coding */
  795.     int chunked;
  796.     /** The Range: header */
  797.     const char *range;
  798.     /** The "real" content length */
  799.     apr_off_t clength;
  800.  
  801.     /** Remaining bytes left to read from the request body */
  802.     apr_off_t remaining;
  803.     /** Number of bytes that have been read  from the request body */
  804.     apr_off_t read_length;
  805.     /** Method for reading the request body
  806.      * (eg. REQUEST_CHUNKED_ERROR, REQUEST_NO_BODY,
  807.      *  REQUEST_CHUNKED_DECHUNK, etc...) */
  808.     int read_body;
  809.     /** reading chunked transfer-coding */
  810.     int read_chunked;
  811.     /** is client waiting for a 100 response? */
  812.     unsigned expecting_100;
  813.  
  814.     /* MIME header environments, in and out.  Also, an array containing
  815.      * environment variables to be passed to subprocesses, so people can
  816.      * write modules to add to that environment.
  817.      *
  818.      * The difference between headers_out and err_headers_out is that the
  819.      * latter are printed even on error, and persist across internal redirects
  820.      * (so the headers printed for ErrorDocument handlers will have them).
  821.      *
  822.      * The 'notes' apr_table_t is for notes from one module to another, with no
  823.      * other set purpose in mind...
  824.      */
  825.  
  826.     /** MIME header environment from the request */
  827.     apr_table_t *headers_in;
  828.     /** MIME header environment for the response */
  829.     apr_table_t *headers_out;
  830.     /** MIME header environment for the response, printed even on errors and
  831.      * persist across internal redirects */
  832.     apr_table_t *err_headers_out;
  833.     /** Array of environment variables to be used for sub processes */
  834.     apr_table_t *subprocess_env;
  835.     /** Notes from one module to another */
  836.     apr_table_t *notes;
  837.  
  838.     /* content_type, handler, content_encoding, and all content_languages 
  839.      * MUST be lowercased strings.  They may be pointers to static strings;
  840.      * they should not be modified in place.
  841.      */
  842.     /** The content-type for the current request */
  843.     const char *content_type;    /* Break these out --- we dispatch on 'em */
  844.     /** The handler string that we use to call a handler function */
  845.     const char *handler;    /* What we *really* dispatch on */
  846.  
  847.     /** How to encode the data */
  848.     const char *content_encoding;
  849.     /** Array of strings representing the content languages */
  850.     apr_array_header_t *content_languages;
  851.  
  852.     /** variant list validator (if negotiated) */
  853.     char *vlist_validator;
  854.     
  855.     /** If an authentication check was made, this gets set to the user name. */
  856.     char *user;    
  857.     /** If an authentication check was made, this gets set to the auth type. */
  858.     char *ap_auth_type;
  859.  
  860.     /** This response can not be cached */
  861.     int no_cache;
  862.     /** There is no local copy of this response */
  863.     int no_local_copy;
  864.  
  865.     /* What object is being requested (either directly, or via include
  866.      * or content-negotiation mapping).
  867.      */
  868.  
  869.     /** The URI without any parsing performed */
  870.     char *unparsed_uri;    
  871.     /** The path portion of the URI */
  872.     char *uri;
  873.     /** The filename on disk corresponding to this response */
  874.     char *filename;
  875.     /* XXX: What does this mean? Please define "canonicalize" -aaron */
  876.     /** The true filename, we canonicalize r->filename if these don't match */
  877.     char *canonical_filename;
  878.     /** The PATH_INFO extracted from this request */
  879.     char *path_info;
  880.     /** The QUERY_ARGS extracted from this request */
  881.     char *args;    
  882.     /** ST_MODE set to zero if no such file */
  883.     apr_finfo_t finfo;
  884.     /** A struct containing the components of URI */
  885.     apr_uri_t parsed_uri;
  886.  
  887.     /**
  888.      * Flag for the handler to accept or reject path_info on 
  889.      * the current request.  All modules should respect the
  890.      * AP_REQ_ACCEPT_PATH_INFO and AP_REQ_REJECT_PATH_INFO 
  891.      * values, while AP_REQ_DEFAULT_PATH_INFO indicates they
  892.      * may follow existing conventions.  This is set to the
  893.      * user's preference upon HOOK_VERY_FIRST of the fixups.
  894.      */
  895.     int used_path_info;
  896.  
  897.     /* Various other config info which may change with .htaccess files
  898.      * These are config vectors, with one void* pointer for each module
  899.      * (the thing pointed to being the module's business).
  900.      */
  901.  
  902.     /** Options set in config files, etc. */
  903.     struct ap_conf_vector_t *per_dir_config;
  904.     /** Notes on *this* request */
  905.     struct ap_conf_vector_t *request_config;
  906.  
  907.     /**
  908.      * A linked list of the .htaccess configuration directives
  909.      * accessed by this request.
  910.      * N.B. always add to the head of the list, _never_ to the end.
  911.      * that way, a sub request's list can (temporarily) point to a parent's list
  912.      */
  913.     const struct htaccess_result *htaccess;
  914.  
  915.     /** A list of output filters to be used for this request */
  916.     struct ap_filter_t *output_filters;
  917.     /** A list of input filters to be used for this request */
  918.     struct ap_filter_t *input_filters;
  919.  
  920.     /** A list of protocol level output filters to be used for this
  921.      *  request */
  922.     struct ap_filter_t *proto_output_filters;
  923.     /** A list of protocol level input filters to be used for this
  924.      *  request */
  925.     struct ap_filter_t *proto_input_filters;
  926.  
  927.     /** A flag to determine if the eos bucket has been sent yet */
  928.     int eos_sent;
  929.  
  930. /* Things placed at the end of the record to avoid breaking binary
  931.  * compatibility.  It would be nice to remember to reorder the entire
  932.  * record to improve 64bit alignment the next time we need to break
  933.  * binary compatibility for some other reason.
  934.  */
  935. };
  936.  
  937. /**
  938.  * @defgroup ProxyReq Proxy request types
  939.  *
  940.  * Possible values of request_rec->proxyreq. A request could be normal,
  941.  *  proxied or reverse proxied. Normally proxied and reverse proxied are
  942.  *  grouped together as just "proxied", but sometimes it's necessary to
  943.  *  tell the difference between the two, such as for authentication.
  944.  * @{
  945.  */
  946.  
  947. #define PROXYREQ_NONE 0        /**< No proxy */
  948. #define PROXYREQ_PROXY 1    /**< Standard proxy */
  949. #define PROXYREQ_REVERSE 2    /**< Reverse proxy */
  950. #define PROXYREQ_RESPONSE 3 /**< Origin response */
  951.  
  952. /* @} */
  953.  
  954.  
  955. /** Structure to store things which are per connection */
  956. struct conn_rec {
  957.     /** Pool associated with this connection */
  958.     apr_pool_t *pool;
  959.     /** Physical vhost this conn came in on */
  960.     server_rec *base_server;
  961.     /** used by http_vhost.c */
  962.     void *vhost_lookup_data;
  963.  
  964.     /* Information about the connection itself */
  965.     /** local address */
  966.     apr_sockaddr_t *local_addr;
  967.     /** remote address */
  968.     apr_sockaddr_t *remote_addr;
  969.  
  970.     /** Client's IP address */
  971.     char *remote_ip;
  972.     /** Client's DNS name, if known.  NULL if DNS hasn't been checked,
  973.      *  "" if it has and no address was found.  N.B. Only access this though
  974.      * get_remote_host() */
  975.     char *remote_host;
  976.     /** Only ever set if doing rfc1413 lookups.  N.B. Only access this through
  977.      *  get_remote_logname() */
  978.     char *remote_logname;
  979.  
  980.     /** Are we still talking? */
  981.     unsigned aborted:1;
  982.  
  983.     /** Are we going to keep the connection alive for another request?
  984.      *  -1 fatal error, 0 undecided, 1 yes   */
  985.     signed int keepalive:2;
  986.  
  987.     /** have we done double-reverse DNS? -1 yes/failure, 0 not yet, 
  988.      *  1 yes/success */
  989.     signed int double_reverse:2;
  990.  
  991.     /** How many times have we used it? */
  992.     int keepalives;
  993.     /** server IP address */
  994.     char *local_ip;
  995.     /** used for ap_get_server_name when UseCanonicalName is set to DNS
  996.      *  (ignores setting of HostnameLookups) */
  997.     char *local_host;
  998.  
  999.     /** ID of this connection; unique at any point in time */
  1000.     long id; 
  1001.     /** Notes on *this* connection */
  1002.     struct ap_conf_vector_t *conn_config;
  1003.     /** send note from one module to another, must remain valid for all
  1004.      *  requests on this conn */
  1005.     apr_table_t *notes;
  1006.     /** A list of input filters to be used for this connection */
  1007.     struct ap_filter_t *input_filters;
  1008.     /** A list of output filters to be used for this connection */
  1009.     struct ap_filter_t *output_filters;
  1010.     /** handle to scoreboard information for this connection */
  1011.     void *sbh;
  1012.     /** The bucket allocator to use for all bucket/brigade creations */
  1013.     struct apr_bucket_alloc_t *bucket_alloc;
  1014. };
  1015.  
  1016. /* Per-vhost config... */
  1017.  
  1018. /**
  1019.  * The address 255.255.255.255, when used as a virtualhost address,
  1020.  * will become the "default" server when the ip doesn't match other vhosts.
  1021.  */
  1022. #define DEFAULT_VHOST_ADDR 0xfffffffful
  1023.  
  1024.  
  1025. /** A structure to be used for Per-vhost config */
  1026. typedef struct server_addr_rec server_addr_rec;
  1027. struct server_addr_rec {
  1028.     /** The next server in the list */
  1029.     server_addr_rec *next;
  1030.     /** The bound address, for this server */
  1031.     apr_sockaddr_t *host_addr;
  1032.     /** The bound port, for this server */
  1033.     apr_port_t host_port;
  1034.     /** The name given in <VirtualHost> */
  1035.     char *virthost;
  1036. };
  1037.  
  1038. /** A structure to store information for each virtual server */
  1039. struct server_rec {
  1040.     /** The process this server is running in */
  1041.     process_rec *process;
  1042.     /** The next server in the list */
  1043.     server_rec *next;
  1044.  
  1045.     /** The name of the server */
  1046.     const char *defn_name;
  1047.     /** The line of the config file that the server was defined on */
  1048.     unsigned defn_line_number;
  1049.  
  1050.     /* Contact information */
  1051.  
  1052.     /** The admin's contact information */
  1053.     char *server_admin;
  1054.     /** The server hostname */
  1055.     char *server_hostname;
  1056.     /** for redirects, etc. */
  1057.     apr_port_t port;
  1058.  
  1059.     /* Log files --- note that transfer log is now in the modules... */
  1060.  
  1061.     /** The name of the error log */
  1062.     char *error_fname;
  1063.     /** A file descriptor that references the error log */
  1064.     apr_file_t *error_log;
  1065.     /** The log level for this server */
  1066.     int loglevel;
  1067.  
  1068.     /* Module-specific configuration for server, and defaults... */
  1069.  
  1070.     /** true if this is the virtual server */
  1071.     int is_virtual;
  1072.     /** Config vector containing pointers to modules' per-server config 
  1073.      *  structures. */
  1074.     struct ap_conf_vector_t *module_config; 
  1075.     /** MIME type info, etc., before we start checking per-directory info */
  1076.     struct ap_conf_vector_t *lookup_defaults;
  1077.  
  1078.     /* Transaction handling */
  1079.  
  1080.     /** I haven't got a clue */
  1081.     server_addr_rec *addrs;
  1082.     /** Timeout, as an apr interval, before we give up */
  1083.     apr_interval_time_t timeout;
  1084.     /** The apr interval we will wait for another request */
  1085.     apr_interval_time_t keep_alive_timeout;
  1086.     /** Maximum requests per connection */
  1087.     int keep_alive_max;
  1088.     /** Use persistent connections? */
  1089.     int keep_alive;
  1090.  
  1091.     /** Pathname for ServerPath */
  1092.     const char *path;
  1093.     /** Length of path */
  1094.     int pathlen;
  1095.  
  1096.     /** Normal names for ServerAlias servers */
  1097.     apr_array_header_t *names;
  1098.     /** Wildcarded names for ServerAlias servers */
  1099.     apr_array_header_t *wild_names;
  1100.  
  1101.     /** limit on size of the HTTP request line    */
  1102.     int limit_req_line;
  1103.     /** limit on size of any request header field */
  1104.     int limit_req_fieldsize;
  1105.     /** limit on number of request header fields  */
  1106.     int limit_req_fields; 
  1107. };
  1108.  
  1109. typedef struct core_output_filter_ctx {
  1110.     apr_bucket_brigade *b;
  1111.     apr_pool_t *subpool; /* subpool of c->pool used for data saved after a
  1112.                           * request is finished
  1113.                           */
  1114.     int subpool_has_stuff; /* anything in the subpool? */
  1115. } core_output_filter_ctx_t;
  1116.  
  1117. typedef struct core_filter_ctx {
  1118.     apr_bucket_brigade *b;
  1119. } core_ctx_t;
  1120.  
  1121. typedef struct core_net_rec {
  1122.     /** Connection to the client */
  1123.     apr_socket_t *client_socket;
  1124.  
  1125.     /** connection record */
  1126.     conn_rec *c;
  1127.  
  1128.     core_output_filter_ctx_t *out_ctx;
  1129.     core_ctx_t *in_ctx;
  1130. } core_net_rec;
  1131.  
  1132. /**
  1133.  * Examine a field value (such as a media-/content-type) string and return
  1134.  * it sans any parameters; e.g., strip off any ';charset=foo' and the like.
  1135.  * @param p Pool to allocate memory from
  1136.  * @param intype The field to examine
  1137.  * @return A copy of the field minus any parameters
  1138.  */
  1139. AP_DECLARE(char *) ap_field_noparam(apr_pool_t *p, const char *intype);
  1140.  
  1141. /**
  1142.  * Convert a time from an integer into a string in a specified format
  1143.  * @param p The pool to allocate memory from
  1144.  * @param t The time to convert
  1145.  * @param fmt The format to use for the conversion
  1146.  * @param gmt Convert the time for GMT?
  1147.  * @return The string that represents the specified time
  1148.  */
  1149. AP_DECLARE(char *) ap_ht_time(apr_pool_t *p, apr_time_t t, const char *fmt, int gmt);
  1150.  
  1151. /* String handling. The *_nc variants allow you to use non-const char **s as
  1152.    arguments (unfortunately C won't automatically convert a char ** to a const
  1153.    char **) */
  1154.  
  1155. /**
  1156.  * Get the characters until the first occurance of a specified character
  1157.  * @param p The pool to allocate memory from
  1158.  * @param line The string to get the characters from
  1159.  * @param stop The character to stop at
  1160.  * @return A copy of the characters up to the first stop character
  1161.  */
  1162. AP_DECLARE(char *) ap_getword(apr_pool_t *p, const char **line, char stop);
  1163. /**
  1164.  * Get the characters until the first occurance of a specified character
  1165.  * @param p The pool to allocate memory from
  1166.  * @param line The string to get the characters from
  1167.  * @param stop The character to stop at
  1168.  * @return A copy of the characters up to the first stop character
  1169.  * @note This is the same as ap_getword(), except it doesn't use const char **.
  1170.  */
  1171. AP_DECLARE(char *) ap_getword_nc(apr_pool_t *p, char **line, char stop);
  1172.  
  1173. /**
  1174.  * Get the first word from a given string.  A word is defined as all characters
  1175.  * up to the first whitespace.
  1176.  * @param p The pool to allocate memory from
  1177.  * @param line The string to traverse
  1178.  * @return The first word in the line
  1179.  */
  1180. AP_DECLARE(char *) ap_getword_white(apr_pool_t *p, const char **line);
  1181. /**
  1182.  * Get the first word from a given string.  A word is defined as all characters
  1183.  * up to the first whitespace.
  1184.  * @param p The pool to allocate memory from
  1185.  * @param line The string to traverse
  1186.  * @return The first word in the line
  1187.  * @note The same as ap_getword_white(), except it doesn't use const char **.
  1188.  */
  1189. AP_DECLARE(char *) ap_getword_white_nc(apr_pool_t *p, char **line);
  1190.  
  1191. /**
  1192.  * Get all characters from the first occurance of @a stop to the first '\0'
  1193.  * @param p The pool to allocate memory from
  1194.  * @param line The line to traverse
  1195.  * @param stop The character to start at
  1196.  * @return A copy of all caracters after the first occurance of the specified
  1197.  *         character
  1198.  */
  1199. AP_DECLARE(char *) ap_getword_nulls(apr_pool_t *p, const char **line,
  1200.                     char stop);
  1201. /**
  1202.  * Get all characters from the first occurance of @a stop to the first '\0'
  1203.  * @param p The pool to allocate memory from
  1204.  * @param line The line to traverse
  1205.  * @param stop The character to start at
  1206.  * @return A copy of all caracters after the first occurance of the specified
  1207.  *         character
  1208.  * @note The same as ap_getword_nulls(), except it doesn't use const char **.
  1209.  */
  1210. AP_DECLARE(char *) ap_getword_nulls_nc(apr_pool_t *p, char **line, char stop);
  1211.  
  1212. /**
  1213.  * Get the second word in the string paying attention to quoting
  1214.  * @param p The pool to allocate from
  1215.  * @param line The line to traverse
  1216.  * @return A copy of the string
  1217.  */
  1218. AP_DECLARE(char *) ap_getword_conf(apr_pool_t *p, const char **line);
  1219. /**
  1220.  * Get the second word in the string paying attention to quoting
  1221.  * @param p The pool to allocate from
  1222.  * @param line The line to traverse
  1223.  * @return A copy of the string
  1224.  * @note The same as ap_getword_conf(), except it doesn't use const char **.
  1225.  */
  1226. AP_DECLARE(char *) ap_getword_conf_nc(apr_pool_t *p, char **line);
  1227.  
  1228. /**
  1229.  * Check a string for any ${ENV} environment variable construct and replace 
  1230.  * each them by the value of that environment variable, if it exists. If the 
  1231.  * environment value does not exist, leave the ${ENV} construct alone; it 
  1232.  * means something else.
  1233.  * @param p The pool to allocate from
  1234.  * @param word The string to check
  1235.  * @return The string with the replaced environment variables
  1236.  */
  1237. AP_DECLARE(const char *) ap_resolve_env(apr_pool_t *p, const char * word); 
  1238.  
  1239. /**
  1240.  * Size an HTTP header field list item, as separated by a comma.
  1241.  * @param field The field to size
  1242.  * @param len The length of the field
  1243.  * @return The return value is a pointer to the beginning of the non-empty 
  1244.  * list item within the original string (or NULL if there is none) and the 
  1245.  * address of field is shifted to the next non-comma, non-whitespace 
  1246.  * character.  len is the length of the item excluding any beginning whitespace.
  1247.  */
  1248. AP_DECLARE(const char *) ap_size_list_item(const char **field, int *len);
  1249.  
  1250. /**
  1251.  * Retrieve an HTTP header field list item, as separated by a comma,
  1252.  * while stripping insignificant whitespace and lowercasing anything not in
  1253.  * a quoted string or comment.  
  1254.  * @param p The pool to allocate from
  1255.  * @param field The field to retrieve
  1256.  * @return The return value is a new string containing the converted list 
  1257.  *         item (or NULL if none) and the address pointed to by field is 
  1258.  *         shifted to the next non-comma, non-whitespace.
  1259.  */
  1260. AP_DECLARE(char *) ap_get_list_item(apr_pool_t *p, const char **field);
  1261.  
  1262. /**
  1263.  * Find an item in canonical form (lowercase, no extra spaces) within
  1264.  * an HTTP field value list.  
  1265.  * @param p The pool to allocate from
  1266.  * @param line The field value list to search
  1267.  * @param tok The token to search for
  1268.  * @return 1 if found, 0 if not found.
  1269.  */
  1270. AP_DECLARE(int) ap_find_list_item(apr_pool_t *p, const char *line, const char *tok);
  1271.  
  1272. /**
  1273.  * Retrieve a token, spacing over it and returning a pointer to
  1274.  * the first non-white byte afterwards.  Note that these tokens
  1275.  * are delimited by semis and commas and can also be delimited
  1276.  * by whitespace at the caller's option.
  1277.  * @param p The pool to allocate from
  1278.  * @param accept_line The line to retrieve the token from
  1279.  * @param accept_white Is it delimited by whitespace
  1280.  * @return the first non-white byte after the token
  1281.  */
  1282. AP_DECLARE(char *) ap_get_token(apr_pool_t *p, const char **accept_line, int accept_white);
  1283.  
  1284. /**
  1285.  * Find http tokens, see the definition of token from RFC2068 
  1286.  * @param p The pool to allocate from
  1287.  * @param line The line to find the token
  1288.  * @param tok The token to find
  1289.  * @return 1 if the token is found, 0 otherwise
  1290.  */
  1291. AP_DECLARE(int) ap_find_token(apr_pool_t *p, const char *line, const char *tok);
  1292.  
  1293. /**
  1294.  * find http tokens from the end of the line
  1295.  * @param p The pool to allocate from
  1296.  * @param line The line to find the token
  1297.  * @param tok The token to find
  1298.  * @return 1 if the token is found, 0 otherwise
  1299.  */
  1300. AP_DECLARE(int) ap_find_last_token(apr_pool_t *p, const char *line, const char *tok);
  1301.  
  1302. /**
  1303.  * Check for an Absolute URI syntax
  1304.  * @param u The string to check
  1305.  * @return 1 if URI, 0 otherwise
  1306.  */
  1307. AP_DECLARE(int) ap_is_url(const char *u);
  1308.  
  1309. /**
  1310.  * Unescape a URL
  1311.  * @param url The url to unescapte
  1312.  * @return 0 on success, non-zero otherwise
  1313.  */
  1314. AP_DECLARE(int) ap_unescape_url(char *url);
  1315. /**
  1316.  * Convert all double slashes to single slashes
  1317.  * @param name The string to convert
  1318.  */
  1319. AP_DECLARE(void) ap_no2slash(char *name);
  1320.  
  1321. /**
  1322.  * Remove all ./ and xx/../ substrings from a file name. Also remove
  1323.  * any leading ../ or /../ substrings.
  1324.  * @param name the file name to parse
  1325.  */
  1326. AP_DECLARE(void) ap_getparents(char *name);
  1327.  
  1328. /**
  1329.  * Escape a path segment, as defined in RFC 1808
  1330.  * @param p The pool to allocate from
  1331.  * @param s The path to convert
  1332.  * @return The converted URL
  1333.  */
  1334. AP_DECLARE(char *) ap_escape_path_segment(apr_pool_t *p, const char *s);
  1335. /**
  1336.  * convert an OS path to a URL in an OS dependant way.
  1337.  * @param p The pool to allocate from
  1338.  * @param path The path to convert
  1339.  * @param partial if set, assume that the path will be appended to something
  1340.  *        with a '/' in it (and thus does not prefix "./")
  1341.  * @return The converted URL
  1342.  */
  1343. AP_DECLARE(char *) ap_os_escape_path(apr_pool_t *p, const char *path, int partial);
  1344. /** @see ap_os_escape_path */
  1345. #define ap_escape_uri(ppool,path) ap_os_escape_path(ppool,path,1)
  1346.  
  1347. /**
  1348.  * Escape an html string
  1349.  * @param p The pool to allocate from
  1350.  * @param s The html to escape
  1351.  * @return The escaped string
  1352.  */
  1353. AP_DECLARE(char *) ap_escape_html(apr_pool_t *p, const char *s);
  1354.  
  1355. /**
  1356.  * Construct a full hostname
  1357.  * @param p The pool to allocate from
  1358.  * @param hostname The hostname of the server
  1359.  * @param port The port the server is running on
  1360.  * @param r The current request
  1361.  * @return The server's hostname
  1362.  */
  1363. AP_DECLARE(char *) ap_construct_server(apr_pool_t *p, const char *hostname,
  1364.                     apr_port_t port, const request_rec *r);
  1365. /**
  1366.  * Escape a shell command
  1367.  * @param p The pool to allocate from
  1368.  * @param s The command to escape
  1369.  * @return The escaped shell command
  1370.  */
  1371. AP_DECLARE(char *) ap_escape_shell_cmd(apr_pool_t *p, const char *s);
  1372.  
  1373. /**
  1374.  * Count the number of directories in a path
  1375.  * @param path The path to count
  1376.  * @return The number of directories
  1377.  */
  1378. AP_DECLARE(int) ap_count_dirs(const char *path);
  1379.  
  1380. /**
  1381.  * Copy at most @a n leading directories of @a s into @a d. @a d
  1382.  * should be at least as large as @a s plus 1 extra byte
  1383.  *
  1384.  * @param d The location to copy to
  1385.  * @param s The location to copy from
  1386.  * @param n The number of directories to copy
  1387.  * @return value is the ever useful pointer to the trailing \0 of d
  1388.  * @note on platforms with drive letters, n = 0 returns the "/" root, 
  1389.  * whereas n = 1 returns the "d:/" root.  On all other platforms, n = 0
  1390.  * returns the empty string.  */
  1391. AP_DECLARE(char *) ap_make_dirstr_prefix(char *d, const char *s, int n);
  1392.  
  1393. /**
  1394.  * Return the parent directory name (including trailing /) of the file
  1395.  * @a s
  1396.  * @param p The pool to allocate from
  1397.  * @param s The file to get the parent of
  1398.  * @return A copy of the file's parent directory
  1399.  */
  1400. AP_DECLARE(char *) ap_make_dirstr_parent(apr_pool_t *p, const char *s);
  1401.  
  1402. /**
  1403.  * Given a directory and filename, create a single path from them.  This
  1404.  * function is smart enough to ensure that there is a sinlge '/' between the
  1405.  * directory and file names
  1406.  * @param a The pool to allocate from
  1407.  * @param dir The directory name
  1408.  * @param f The filename
  1409.  * @return A copy of the full path
  1410.  * @tip Never consider using this function if you are dealing with filesystem
  1411.  * names that need to remain canonical, unless you are merging an apr_dir_read
  1412.  * path and returned filename.  Otherwise, the result is not canonical.
  1413.  */
  1414. AP_DECLARE(char *) ap_make_full_path(apr_pool_t *a, const char *dir, const char *f);
  1415.  
  1416. /**
  1417.  * Test if the given path has an an absolute path.
  1418.  * @param p The pool to allocate from
  1419.  * @param dir The directory name
  1420.  * @tip The converse is not necessarily true, some OS's (Win32/OS2/Netware) have
  1421.  * multiple forms of absolute paths.  This only reports if the path is absolute
  1422.  * in a canonical sense.
  1423.  */
  1424. AP_DECLARE(int) ap_os_is_path_absolute(apr_pool_t *p, const char *dir);
  1425.  
  1426. /**
  1427.  * Does the provided string contain wildcard characters?  This is useful
  1428.  * for determining if the string should be passed to strcmp_match or to strcmp.
  1429.  * The only wildcard characters recognized are '?' and '*'
  1430.  * @param str The string to check
  1431.  * @return 1 if the string has wildcards, 0 otherwise
  1432.  */
  1433. AP_DECLARE(int) ap_is_matchexp(const char *str);
  1434.  
  1435. /**
  1436.  * Determine if a string matches a patterm containing the wildcards '?' or '*'
  1437.  * @param str The string to check
  1438.  * @param exp The pattern to match against
  1439.  * @return 1 if the two strings match, 0 otherwise
  1440.  */
  1441. AP_DECLARE(int) ap_strcmp_match(const char *str, const char *exp);
  1442. /**
  1443.  * Determine if a string matches a patterm containing the wildcards '?' or '*',
  1444.  * ignoring case
  1445.  * @param str The string to check
  1446.  * @param exp The pattern to match against
  1447.  * @return 1 if the two strings match, 0 otherwise
  1448.  */
  1449. AP_DECLARE(int) ap_strcasecmp_match(const char *str, const char *exp);
  1450.  
  1451. /**
  1452.  * Find the first occurrence of the substring s2 in s1, regardless of case
  1453.  * @param s1 The string to search
  1454.  * @param s2 The substring to search for
  1455.  * @return A pointer to the beginning of the substring
  1456.  */
  1457. AP_DECLARE(char *) ap_strcasestr(const char *s1, const char *s2);
  1458.  
  1459. /**
  1460.  * Return a pointer to the location inside of bigstring immediately after prefix
  1461.  * @param bigstring The input string
  1462.  * @param prefix The prefix to strip away
  1463.  * @return A pointer relative to bigstring after prefix
  1464.  */
  1465. AP_DECLARE(const char *) ap_stripprefix(const char *bigstring,
  1466.                                         const char *prefix);
  1467.  
  1468. /**
  1469.  * Decode a base64 encoded string into memory allocated from a pool
  1470.  * @param p The pool to allocate from
  1471.  * @param bufcoded The encoded string
  1472.  * @return The decoded string
  1473.  */
  1474. AP_DECLARE(char *) ap_pbase64decode(apr_pool_t *p, const char *bufcoded);
  1475.  
  1476. /**
  1477.  * Encode a string into memory allocated from a pool in base 64 format
  1478.  * @param p The pool to allocate from
  1479.  * @param strin The plaintext string
  1480.  * @return The encoded string
  1481.  */
  1482. AP_DECLARE(char *) ap_pbase64encode(apr_pool_t *p, char *string); 
  1483.  
  1484.  
  1485. /**
  1486.  * Compile a regular expression to be used later
  1487.  * @param p The pool to allocate from
  1488.  * @param pattern the regular expression to compile
  1489.  * @param cflags The bitwise or of one or more of the following:
  1490.  *   @li #REG_EXTENDED - Use POSIX extended Regular Expressions
  1491.  *   @li #REG_ICASE    - Ignore case
  1492.  *   @li #REG_NOSUB    - Support for substring addressing of matches
  1493.  *       not required
  1494.  *   @li #REG_NEWLINE  - Match-any-character operators don't match new-line
  1495.  * @return The compiled regular expression
  1496.  */
  1497. AP_DECLARE(regex_t *) ap_pregcomp(apr_pool_t *p, const char *pattern,
  1498.                    int cflags);
  1499.  
  1500. /**
  1501.  * Free the memory associated with a compiled regular expression
  1502.  * @param p The pool the regex was allocated from
  1503.  * @param reg The regular expression to free
  1504.  */
  1505. AP_DECLARE(void) ap_pregfree(apr_pool_t *p, regex_t *reg);
  1506.  
  1507. /**
  1508.  * Match a null-terminated string against a pre-compiled regex.
  1509.  * @param preg The pre-compiled regex
  1510.  * @param string The string to match
  1511.  * @param nmatch Provide information regarding the location of any matches
  1512.  * @param pmatch Provide information regarding the location of any matches
  1513.  * @param eflags Bitwise or of any of:
  1514.  *   @li #REG_NOTBOL - match-beginning-of-line operator always
  1515.  *     fails to match
  1516.  *   @li #REG_NOTEOL - match-end-of-line operator always fails to match
  1517.  * @return 0 for successful match, #REG_NOMATCH otherwise
  1518.  */ 
  1519. AP_DECLARE(int)    ap_regexec(regex_t *preg, const char *string,
  1520.                               size_t nmatch, regmatch_t pmatch[], int eflags);
  1521.  
  1522. /**
  1523.  * Return the error code returned by regcomp or regexec into error messages
  1524.  * @param errcode the error code returned by regexec or regcomp
  1525.  * @param preg The precompiled regex
  1526.  * @param errbuf A buffer to store the error in
  1527.  * @param errbuf_size The size of the buffer
  1528.  */
  1529. AP_DECLARE(size_t) ap_regerror(int errcode, const regex_t *preg, 
  1530.                                char *errbuf, size_t errbuf_size);
  1531.  
  1532. /**
  1533.  * After performing a successful regex match, you may use this function to 
  1534.  * perform a series of string substitutions based on subexpressions that were
  1535.  * matched during the call to ap_regexec
  1536.  * @param p The pool to allocate from
  1537.  * @param input An arbitrary string containing $1 through $9.  These are 
  1538.  *              replaced with the corresponding matched sub-expressions
  1539.  * @param source The string that was originally matched to the regex
  1540.  * @param nmatch the nmatch returned from ap_pregex
  1541.  * @param pmatch the pmatch array returned from ap_pregex
  1542.  */
  1543. AP_DECLARE(char *) ap_pregsub(apr_pool_t *p, const char *input, const char *source,
  1544.                               size_t nmatch, regmatch_t pmatch[]);
  1545.  
  1546. /**
  1547.  * We want to downcase the type/subtype for comparison purposes
  1548.  * but nothing else because ;parameter=foo values are case sensitive.
  1549.  * @param s The content-type to convert to lowercase
  1550.  */
  1551. AP_DECLARE(void) ap_content_type_tolower(char *s);
  1552.  
  1553. /**
  1554.  * convert a string to all lowercase
  1555.  * @param s The string to convert to lowercase 
  1556.  */
  1557. AP_DECLARE(void) ap_str_tolower(char *s);
  1558.  
  1559. /**
  1560.  * Search a string from left to right for the first occurrence of a 
  1561.  * specific character
  1562.  * @param str The string to search
  1563.  * @param c The character to search for
  1564.  * @return The index of the first occurrence of c in str
  1565.  */
  1566. AP_DECLARE(int) ap_ind(const char *str, char c);    /* Sigh... */
  1567.  
  1568. /**
  1569.  * Search a string from right to left for the first occurrence of a 
  1570.  * specific character
  1571.  * @param str The string to search
  1572.  * @param c The character to search for
  1573.  * @return The index of the first occurrence of c in str
  1574.  */
  1575. AP_DECLARE(int) ap_rind(const char *str, char c);
  1576.  
  1577. /**
  1578.  * Given a string, replace any bare " with \" .
  1579.  * @param p The pool to allocate memory from
  1580.  * @param instring The string to search for "
  1581.  * @return A copy of the string with escaped quotes 
  1582.  */
  1583. AP_DECLARE(char *) ap_escape_quotes(apr_pool_t *p, const char *instring);
  1584.  
  1585. /* Misc system hackery */
  1586. /**
  1587.  * Given the name of an object in the file system determine if it is a directory
  1588.  * @param p The pool to allocate from 
  1589.  * @param name The name of the object to check
  1590.  * @return 1 if it is a directory, 0 otherwise
  1591.  */
  1592. AP_DECLARE(int) ap_is_rdirectory(apr_pool_t *p, const char *name);
  1593.  
  1594. /**
  1595.  * Given the name of an object in the file system determine if it is a directory - this version is symlink aware
  1596.  * @param p The pool to allocate from 
  1597.  * @param name The name of the object to check
  1598.  * @return 1 if it is a directory, 0 otherwise
  1599.  */
  1600. AP_DECLARE(int) ap_is_directory(apr_pool_t *p, const char *name);
  1601.  
  1602. #ifdef _OSD_POSIX
  1603. extern const char *os_set_account(apr_pool_t *p, const char *account);
  1604. extern int os_init_job_environment(server_rec *s, const char *user_name, int one_process);
  1605. #endif /* _OSD_POSIX */
  1606.  
  1607. /**
  1608.  * Determine the local host name for the current machine
  1609.  * @param p The pool to allocate from
  1610.  * @return A copy of the local host name
  1611.  */
  1612. char *ap_get_local_host(apr_pool_t *p);
  1613.  
  1614. /**
  1615.  * Log an assertion to the error log
  1616.  * @param szExp The assertion that failed
  1617.  * @param szFile The file the assertion is in
  1618.  * @param nLine The line the assertion is defined on
  1619.  */
  1620. AP_DECLARE(void) ap_log_assert(const char *szExp, const char *szFile, int nLine)
  1621.                 __attribute__((noreturn));
  1622.  
  1623. /** @internal */
  1624. #define ap_assert(exp) ((exp) ? (void)0 : ap_log_assert(#exp,__FILE__,__LINE__))
  1625.  
  1626. /**
  1627.  * Redefine assert() to something more useful for an Apache...
  1628.  *
  1629.  * Use ap_assert() if the condition should always be checked.
  1630.  * Use AP_DEBUG_ASSERT() if the condition should only be checked when AP_DEBUG
  1631.  * is defined.
  1632.  */
  1633.  
  1634. #ifdef AP_DEBUG
  1635. #define AP_DEBUG_ASSERT(exp) ap_assert(exp)
  1636. #else
  1637. #define AP_DEBUG_ASSERT(exp) ((void)0)
  1638. #endif
  1639.  
  1640. /**
  1641.  * @defgroup stopsignal flags which indicate places where the sever should stop for debugging.
  1642.  * @{
  1643.  * A set of flags which indicate places where the server should raise(SIGSTOP).
  1644.  * This is useful for debugging, because you can then attach to that process
  1645.  * with gdb and continue.  This is important in cases where one_process
  1646.  * debugging isn't possible.
  1647.  */
  1648. /** stop on a Detach */
  1649. #define SIGSTOP_DETACH            1
  1650. /** stop making a child process */
  1651. #define SIGSTOP_MAKE_CHILD        2
  1652. /** stop spawning a child process */
  1653. #define SIGSTOP_SPAWN_CHILD        4
  1654. /** stop spawning a child process with a piped log */
  1655. #define SIGSTOP_PIPED_LOG_SPAWN        8
  1656. /** stop spawning a CGI child process */
  1657. #define SIGSTOP_CGI_CHILD        16
  1658.  
  1659. /** Macro to get GDB started */
  1660. #ifdef DEBUG_SIGSTOP
  1661. extern int raise_sigstop_flags;
  1662. #define RAISE_SIGSTOP(x)    do { \
  1663.     if (raise_sigstop_flags & SIGSTOP_##x) raise(SIGSTOP);\
  1664.     } while (0)
  1665. #else
  1666. #define RAISE_SIGSTOP(x)
  1667. #endif
  1668. /** @} */
  1669. /**
  1670.  * Get HTML describing the address and (optionally) admin of the server.
  1671.  * @param prefix Text which is prepended to the return value
  1672.  * @param r The request_rec
  1673.  * @return HTML describing the server, allocated in @a r's pool.
  1674.  */
  1675. AP_DECLARE(const char *) ap_psignature(const char *prefix, request_rec *r);
  1676.  
  1677. /** strtoul does not exist on sunos4. */
  1678. #ifdef strtoul
  1679. #undef strtoul
  1680. #endif
  1681. #define strtoul strtoul_is_not_a_portable_function_use_strtol_instead
  1682.  
  1683.   /* The C library has functions that allow const to be silently dropped ...
  1684.      these macros detect the drop in maintainer mode, but use the native
  1685.      methods for normal builds
  1686.  
  1687.      Note that on some platforms (e.g., AIX with gcc, Solaris with gcc), string.h needs 
  1688.      to be included before the macros are defined or compilation will fail.
  1689.   */
  1690. #include <string.h>
  1691.  
  1692. #ifdef AP_DEBUG
  1693.  
  1694. #undef strchr
  1695. # define strchr(s, c)    ap_strchr(s,c)
  1696. #undef strrchr
  1697. # define strrchr(s, c)  ap_strrchr(s,c)
  1698. #undef strstr
  1699. # define strstr(s, c)  ap_strstr(s,c)
  1700.  
  1701. AP_DECLARE(char *) ap_strchr(char *s, int c);
  1702. AP_DECLARE(const char *) ap_strchr_c(const char *s, int c);
  1703. AP_DECLARE(char *) ap_strrchr(char *s, int c);
  1704. AP_DECLARE(const char *) ap_strrchr_c(const char *s, int c);
  1705. AP_DECLARE(char *) ap_strstr(char *s, const char *c);
  1706. AP_DECLARE(const char *) ap_strstr_c(const char *s, const char *c);
  1707.  
  1708. #else
  1709.  
  1710. /** use this instead of strchr */
  1711. # define ap_strchr(s, c)    strchr(s, c)
  1712. /** use this instead of strchr */
  1713. # define ap_strchr_c(s, c)    strchr(s, c)
  1714. /** use this instead of strrchr */
  1715. # define ap_strrchr(s, c)    strrchr(s, c)
  1716. /** use this instead of strrchr */
  1717. # define ap_strrchr_c(s, c)    strrchr(s, c)
  1718. /** use this instead of strrstr*/
  1719. # define ap_strstr(s, c)    strstr(s, c)
  1720. /** use this instead of strrstr*/
  1721. # define ap_strstr_c(s, c)    strstr(s, c)
  1722.  
  1723. #endif
  1724.  
  1725. #define AP_NORESTART        APR_OS_START_USEERR + 1
  1726.  
  1727. #ifdef __cplusplus
  1728. }
  1729. #endif
  1730.  
  1731. #endif    /* !APACHE_HTTPD_H */
  1732.